home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 38 / Amiga Format CD38 (1999-03-15)(Future Publishing)(GB)(Track 1 of 3)[!][issue 1999-04].iso / -seriously_amiga- / programming / mui / mcc_twfmultiled / developer / autodocs / mcc_twfmultiled.doc
Text File  |  1999-02-08  |  5KB  |  137 lines
  1. TABLE OF CONTENTS
  2.  
  3. TWFmultiLED.mcc/TWFmultiLED.mcc
  4. TWFmultiLED.mcc/MUIA_TWFmultiLED_Colour
  5. TWFmultiLED.mcc/MUIA_TWFmultiLED_Custom
  6. TWFmultiLED.mcc/MUIA_TWFmultiLED_Type
  7. TWFmultiLED.mcc/MUIA_TWFmultiLED_Free
  8.  
  9. TWFmultiLED.mcc/TWFmultiLED.mcc                  TWFmultiLED.mcc/TWFmultiLED.mcc
  10.  
  11.     This class is a fairly simple implementation of a "LED-like" indicator which
  12. provides the programmer with a new method for communicating program state to
  13. the user. Unlike other similar implementations, TWFmultiLED allows both the
  14. user and programmer to specify both the shape of the indicator and it's colour.
  15.  
  16.     Via the preferences program the user can specify the RGB makeup of the 6
  17. internal colours (used to represent the states "Off", "On", "Ok", "Loading",
  18. "Error" and "Panic") and the default shape of the indicator. The programmer
  19. can abide by the user's choice of shape, or override it and use one fo the
  20. other shapes. The programmer can also set the indicator to any of the 6 user
  21. defined colours or to a custom colour the programmer specifies.
  22.  
  23. TWFmultiLED.mcc/MUIA_TWFmultiLED_Colour
  24.  
  25.   NAME
  26.     MUIA_TWFmultiLED_Colour -- [IS.], ULONG
  27.  
  28.   INPUTS
  29.     MUIV_TWFmultiLED_Colour_Off     Set indicator to user defined Off colour.
  30.     MUIV_TWFmultiLED_Colour_On      Set indicator to user defined On colour.
  31.     MUIV_TWFmultiLED_Colour_Ok      Set indicator to user defined Ok colour.
  32.     MUIV_TWFmultiLED_Colour_Load    Set indicator to user defined Load colour.
  33.     MUIV_TWFmultiLED_Colour_Error   Set indicator to user defined Error colour.
  34.     MUIV_TWFmultiLED_Colour_Panic   Set indicator to user defined Panic colour.
  35.     MUIV_TWFmultiLED_Colour_Custom  Set indicator to programmer specified colour
  36.  
  37.     MUIV_TWFmultiLED_Colour_Off is the default value.
  38.  
  39.   FUNCTION
  40.     This attribute allows you to change the colour shown in the indicator. The
  41.     indicator will only change colour if the value you specify is valid and
  42.     the pen for that colour has been obtained successfully.
  43.  
  44.  
  45.   NOTE
  46.     Specifying MUIV_TWFmultiLED_Colour_Custom will have no effect unless you
  47.     have set a value for MUIA_TWFmultiLED_Custom AND the window is open.
  48.     Specifying MUIV_TWFmultiLED_Colour_Custom during initialisation will have
  49.     no effect.
  50.  
  51.   BUGS
  52.     No known bugs.
  53.  
  54.   SEE ALSO
  55.     MUIA_TWFmultiLED_Custom
  56.  
  57.  
  58. TWFmultiLED.mcc/MUIA_TWFmultiLED_Custom
  59.  
  60.   NAME
  61.     MUIA_TWFmultiLED_Custom -- [IS.], struct TWFmultiLED_RGB *
  62.  
  63.   FUNCTION
  64.     Using this attribute, the programmer can specify an RGB value to display in
  65.     the indicator. The RGB values should be 32 bit left justified fractions
  66.     as used by graphics.library/SetRGB32()
  67.  
  68.   EXAMPLE
  69.  
  70.     struct TWFmultiLED_RGB egColour = { 0xFFFFFFFF, 0, 0xFFFFFFFF };
  71.  
  72.     ...
  73.  
  74.     Child, ML_Indicator = TWFmultiLEDObject,
  75.         ...
  76.     End,
  77.  
  78.     ...
  79.  
  80.     set(ML_Indicator, MUIA_TWFmultiLED_Custom, &egColour);
  81.     set(ML_Indicator, MUIA_TWFmultiLED_Colour, MUIV_TWFmultiLED_Colour_Custom);
  82.  
  83.  
  84.   BUGS
  85.     No known bugs.
  86.  
  87.   SEE ALSO
  88.     MUIA_TWFmultiLED_Colour, graphics.library/SetRGB32
  89.  
  90. TWFmultiLED.mcc/MUIA_TWFmultiLED_Type
  91.  
  92.   NAME
  93.     MUIA_TWFmultiLED_Type -- [IS.], ULONG
  94.  
  95.   INPUTS
  96.     MUIV_TWFmultiLED_Type_Round5    Indicator is drawn as a small circle.
  97.     MUIV_TWFmultiLED_Type_Round11   Indicator is drawn as a large circle.
  98.     MUIV_TWFmultiLED_Type_Square5   Indicator is drawn as a small square.
  99.     MUIV_TWFmultiLED_Type_Square11  Indicator is drawn as a large square.
  100.     MUIV_TWFmultiLED_Type_Rect11    Indicator is drawn as a small rectangle.
  101.     MUIV_TWFmultiLED_Type_Rect15    Indicator is drawn as a large rectangle.
  102.     MUIV_TWFmultiLED_Type_User      The indicator shape is set by the user,
  103.                                     this is the default.
  104.  
  105.   FUNCTION
  106.     This attribute allows the programmer to alter the shape of the indicator.
  107.     This should not be used unless absolutely necessary - the user's
  108.     preference is the default and you should not override it unless you
  109.     have a very good reason.
  110.  
  111.   NOTE
  112.     When you set this attribute, the indicator will be temporarily hidden
  113.     and then redisplayed. This forces MUI to ask for the indicator's
  114.     dimensions but it may affect your layout.
  115.  
  116.   BUGS
  117.     No known bugs.
  118.  
  119.   SEE ALSO
  120.  
  121.  
  122.  
  123. TWFmultiLED.mcc/MUIA_TWFmultiLED_Free
  124.  
  125.   NAME
  126.     MUIA_TWFmultiLED_Free -- [IS.], BOOL
  127.  
  128.   FUNCTION
  129.     This attribute only affects the square and rectangular indicators. If set
  130.     to TRUE then both the maximum height and width are set to 40. The indicator
  131.     will resize as the user changes the window size.
  132.  
  133.   BUGS
  134.     No known bugs.
  135.  
  136.  
  137.